Skip to content

Docs/fix workaround guidance#12

Merged
JeffreyUrban merged 2 commits intomainfrom
docs/fix-workaround-guidance
Dec 20, 2025
Merged

Docs/fix workaround guidance#12
JeffreyUrban merged 2 commits intomainfrom
docs/fix-workaround-guidance

Conversation

@JeffreyUrban
Copy link
Copy Markdown
Owner

This pull request introduces new workflow guidance documents and updates existing documentation to reinforce a culture of fixing root causes rather than working around problems. The changes emphasize mandatory practices for addressing blocking issues and provide clear instructions on how to handle mistakes and documentation improvements.

Workflow and Problem-Fixing Guidance:

  • Added a new .claude/workflows/fixing-issues.md document outlining a universal rule to always fix issues completely, with examples of correct and incorrect approaches to handling blocking issues.
  • Updated CLAUDE.md to include a mandatory section on never working around problems, listing red flags for workarounds, and providing clear examples of wrong and right approaches to fixing issues.

Documentation and Reflection Process:

  • Added guidance in CLAUDE.md requiring contributors to propose concrete documentation changes when mistakes occur, instead of merely apologizing or promising improvement, and to explain how their proposed change would prevent similar issues in the future.

JeffreyUrban and others added 2 commits December 11, 2025 20:38
Add comprehensive workflow document that enforces:
- Treating all blocking issues as in-scope
- Fixing root causes instead of adding workarounds
- Rejecting conditional logic that bypasses problems

This completes the guidance changes to prevent the pattern of
hiding issues with test-skipping logic or deferring fixes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Add two new critical sections to CLAUDE.md:

1. "Never Work Around Problems - Fix Them"
   - Mandatory questions before proposing solutions
   - Red flags indicating workarounds vs fixes
   - Required actions for blocking issues
   - Examples of wrong (workaround) vs right (fix) approaches

2. "Apologies and Promises Are Not Solutions"
   - Requirement for concrete documentation changes
   - Rejection of vague promises without actionable changes
   - Process for identifying and updating failed guidance

These sections prevent the pattern of creating workarounds (like
skipping tests) instead of fixing root causes (like template
placeholders in formulas).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@JeffreyUrban JeffreyUrban merged commit 1479e59 into main Dec 20, 2025
18 checks passed
@JeffreyUrban JeffreyUrban deleted the docs/fix-workaround-guidance branch December 20, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant